Use appropriate check result value when determined not relevant #103
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
silvanocerza
approved these changes
Dec 14, 2020
There are various extents to which a check can be run: 1. Skipped due to check configuration (e.g., check is configured to run for libraries but the project is a sketch). 2. Not run due to a problem not directly related to the check (e.g., invalid library.properties data format). 3. Skipped because the check function determined it was not applicable (e.g., formating check on undefined optional library.properties field). 4. Run. Each has an associated check result value: Skip, NotRun, Pass/Fail. Previously, the "NotRun" result was used for both (2) and (3), but "Skip" is much more appropriate for (3) because this is a situation where there was no reason to run the check, whereas "NotRun" indicates that the check should have been run, but couldn't.
per1234
force-pushed
the
per1234/check-functions-skip
branch
from
d218245 to
401f029
Compare
per1234
added
topic: code
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There are various extents to which a check can be run:
Each has an associated check result value:
Skip,NotRun,Pass/Fail.Previously, the "NotRun" result was used for both (2) and (3), but "Skip" is much more appropriate for (3) because this
is a situation where there was no reason to run the check, whereas "NotRun" indicates that the check should have been
run, but couldn't.